/************************************
*  Copyright (C) 2010 Julien MOTTIN.
*  Contact: julien.mottin@gueydan.eu
*
*  This file is part of Gueydan.
*
*  Gueydan is free software: you can redistribute it and/or modify
*  it under the terms of the GNU General Public License as published by
*  the Free Software Foundation, either version 3 of the License, or
*  (at your option) any later version.
*
*  Gueydan is distributed in the hope that it will be useful,
*  but WITHOUT ANY WARRANTY; without even the implied warranty of
*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
*  GNU General Public License for more details.
*
*  You should have received a copy of the GNU General Public License
*  along with Gueydan.  If not, see <http://www.gnu.org/licenses/>.
*
*************************************/
#ifndef YEAST_H
#define YEAST_H

// Local
#include "volume.h"
#include "weight.h"
#include "temperature.h"
#include "beerxmlobject.h"

// QtCore
#include <QString>

enum YeastType
{
    YTAle = 0,
    YTLager,
    YTWheat,
    YTWine,
    YTChampagne
};

enum YeastForm
{
    YFLiquid = 0,
    YFDry,
    YFSlant,
    YFCulture
};

enum YeastFlocculation
{
    YFlUnset =0,
    YFlLow,
    YFlMedium,
    YFlHigh,
    YFlVeryHigh
};

class QDomNode;

class Yeast : public BeerXMLObject
{
    Q_OBJECT;
    
public:

    // Standard Ctor with all mandatory fields (volume)
    Yeast(const QString &iName,
          const int iVersion,
          const YeastType iType,
          const YeastForm iForm,
          const Volume &iAmount);

    // Standard Ctor with all mandatory fields (weight)
    Yeast(const QString &iName,
          const int iVersion,
          const YeastType iType,
          const YeastForm iForm,
          const Weight &iAmount);

    // convenient operators
    Yeast();
    ~Yeast();
    bool operator==(const Yeast &iOther) const;
    bool operator!=(const Yeast &iOther) const;

    /*
    * XML IO
    * returns :
    *   - 0 : Success
    *   - 1 : Invalid XML
    */
    int CreateFromXMLNode(const QDomNode &iNode);
    int ToXMLNode(QDomNode &iParentNode) const;

public:

    YeastType           _Type;
    YeastForm           _Form;
    Volume              _AmountV;
    Weight              _AmountW;
    bool                _AmountIsWeight;
    QString             _Laboratory;
    QString             _ProductID;
    Temperature         _MinTemperature;
    Temperature         _MaxTemperature;
    YeastFlocculation   _Flocculation;
    float               _Attenuation;
    QString             _Notes;
    QString             _BestFor;
    int                 _TimesCultured;
    int                 _MaxReuse;
    bool                _AddToSecondary;

private:
    Yeast(const Yeast &);
    Yeast & operator=(const Yeast &);
};

#endif // YEAST_H
